Skip to content

Updating quickstart in docs based on apps UI #13987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Sep 20, 2024
Merged

Updating quickstart in docs based on apps UI #13987

merged 4 commits into from
Sep 20, 2024

Conversation

@dannyroosevelt
Copy link
Collaborator

@dannyroosevelt dannyroosevelt commented Sep 18, 2024 •
edited by coderabbitai bot
Loading

Removing references to app_slug and oauth_app_id in the env vars, adding info on linking apps in the apps UI.

  • Need to add info on /info endpoint and new getProjectInfo() method

Summary by CodeRabbit

  • Documentation
    • Reorganized content in the security practices and glossary sections for improved clarity and flow.
    • Revised quickstart documentation for integrating apps, emphasizing action and streamlining instructions for better user navigation.
    • Enhanced readability of project keys and app configuration instructions while maintaining important security information.

@vercel
Copy link

vercel bot commented Sep 18, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
pipedream ❌ Failed (Inspect) Sep 20, 2024 4:31am
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 4:31am
pipedream-docs ⬜️ Ignored (Inspect) Sep 20, 2024 4:31am
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Sep 20, 2024 4:31am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 18, 2024 •
edited
Loading

Walkthrough

The changes involve a reorganization of the documentation to improve clarity and structure. Key modifications include the repositioning of the glossary of terms to the end of the document and a streamlined presentation of the integration process for apps with Pipedream. The revisions aim to enhance the readability and flow of information without altering the content of the glossary or the functionality described.

Changes

File Path Change Summary
docs-v2/pages/connect/index.mdx Reorganized content: moved glossary to the end; reformatted security practices for clarity.
docs-v2/pages/connect/quickstart.mdx Revised integration documentation: changed section title, streamlined steps, and refined wording for clarity.

Possibly related PRs

Poem

🐇 In the garden of docs, we tidy and play,
With terms in their place, they dance and sway.
Security shines, clear paths we create,
For apps to connect, it’s never too late!
So hop on this journey, let clarity bloom,
In the world of integration, there's always more room! 🌼

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2681af7 and a9e1a5d.

Files selected for processing (2)
  • docs-v2/pages/connect/index.mdx (1 hunks)
  • docs-v2/pages/connect/quickstart.mdx (3 hunks)
Files skipped from review due to trivial changes (1)
  • docs-v2/pages/connect/index.mdx
Additional context used
LanguageTool
docs-v2/pages/connect/quickstart.mdx

[style] ~35-~35: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...an add any app to your project that you want to integrate with your application. There...

(REP_WANT_TO_VB)

[uncategorized] ~44-~44: Possible missing comma found.
Context: ...for the app you'd like to integrate. 2. Now when selecting an OAuth app in the **Ap...

(AI_HYDRA_LEO_MISSING_COMMA)

[duplication] ~48-~48: Possible typo: you repeated a word
Context: ...# Get your project keys 1. From within the the Connect tab in your project, select...

(ENGLISH_WORD_REPEAT_RULE)

[style] ~89-~89: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...pecific operations, for example: - You need to initiate the account connection flow fo...

(REP_NEED_TO_VB)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

dylburger
dylburger reviewed Sep 19, 2024
View reviewed changes
docs-v2/pages/connect/index.mdx
- **Use secure, session-based auth between your client and server** — authorize all requests from your client to your server using a secure, session-based auth mechanism. Use well-known identity providers with services like [Clerk](https://clerk.com/), [Firebase](https://firebase.google.com/), or [Auth0](https://auth0.com/) to securely generate and validate authentication tokens. The same follows for Pipedream workflows — if you trigger Pipedream workflows from your client or server, validate all requests in the workflow before executing workflow code.
- **Secure your workflows** — See our [standard security practices](/privacy-and-security/best-practices) for recommendations on securing your Pipedream workflows.

## Glossary of terms
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep this and just put it down bottom? I believe we still link to this section elsewhere

dylburger
dylburger reviewed Sep 19, 2024
View reviewed changes
docs-v2/pages/connect/quickstart.mdx Outdated

<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1723761240/copy-oauth-app-id_on6d8p.png" alt="Copy your OAuth app ID" width={550} height={300} />
**OAuth apps require you [create your own OAuth client](#creating-a-custom-oauth-client):**
- First, [create an OAuth client](/connected-accounts/oauth-clients#configuring-custom-oauth-clients) for the app you'd like to integrate.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make this a numbered list

@dannyroosevelt dannyroosevelt marked this pull request as ready for review September 20, 2024 04:31
@dannyroosevelt dannyroosevelt merged commit 851e0bf into master Sep 20, 2024
6 of 7 checks passed
@dannyroosevelt dannyroosevelt deleted the danny/connect-apps-linking-docs branch September 20, 2024 05:34
@coderabbitai coderabbitai bot mentioned this pull request Sep 27, 2024
Merged
This was referenced Oct 16, 2024
Merged
Merged
This was referenced Oct 31, 2024
Merged
Merged
Open
This was referenced Nov 8, 2024
Merged
Merged
This was referenced Nov 21, 2024
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Dec 6, 2024
Merged
This was referenced Dec 13, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@dylburger dylburger dylburger left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dannyroosevelt @dylburger